/ BCI NET 2 / BCI NET 2.iso / archives / utilities / text / man379.lha / man / man8 / doc2man.8

next >

MacOS 8.1

Win98

DOS

view JSON data

view as text

+--------+-------------------------+-------------------------+--------+--------+
|00000000| 4d 41 4e 01 00 4d 08 64 | 6f 63 32 6d 61 6e 00 4e |MAN..M.d|oc2man.N|
|00000010| 64 6f 63 32 6d 61 6e 20 | 2d 20 63 6f 6e 76 65 72 |doc2man |- conver|
|00000020| 74 20 61 73 63 69 69 20 | 64 6f 63 20 66 69 6c 65 |t ascii |doc file|
|00000030| 20 28 66 6f 72 6d 61 74 | 74 65 64 29 20 74 6f 20 | (format|ted) to |
|00000040| 6d 61 6e 20 70 61 67 65 | 20 66 6f 72 6d 61 74 20 |man page| format |
|00000050| 28 33 37 2e 39 2c 20 46 | 65 62 2f 39 35 29 0a 00 |(37.9, F|eb/95)..|
|00000060| 53 64 6f 63 32 6d 61 6e | 20 3c 69 6e 66 69 6c 65 |Sdoc2man| <infile|
|00000070| 20 3e 6f 75 74 66 69 6c | 65 0a 0a 28 75 73 65 73 | >outfil|e..(uses|
|00000080| 20 73 74 64 69 6f 20 73 | 6f 20 69 2f 6f 20 72 65 | stdio s|o i/o re|
|00000090| 64 69 72 65 63 74 69 6f | 6e 20 77 69 6c 6c 20 62 |directio|n will b|
|000000a0| 65 20 64 65 73 69 72 65 | 64 29 0a 00 44 13 64 6f |e desire|d)..D.do|
|000000b0| 63 32 6d 61 6e 10 20 77 | 69 6c 6c 20 63 6f 6e 76 |c2man. w|ill conv|
|000000c0| 65 72 74 20 61 20 73 70 | 65 63 69 61 6c 6c 79 2d |ert a sp|ecially-|
|000000d0| 66 6f 72 6d 61 74 74 65 | 64 20 74 65 78 74 20 66 |formatte|d text f|
|000000e0| 69 6c 65 20 69 6e 74 6f | 20 61 20 6d 61 6e 75 61 |ile into| a manua|
|000000f0| 6c 20 70 61 67 65 20 66 | 69 6c 65 2c 20 66 6f 72 |l page f|ile, for|
|00000100| 6d 61 74 74 61 62 6c 65 | 20 62 79 20 74 68 65 20 |mattable| by the |
|00000110| 13 6d 61 6e 10 20 70 72 | 6f 67 72 61 6d 2e 20 20 |.man. pr|ogram.  |
|00000120| 53 65 65 20 6f 6e 65 20 | 6f 66 20 74 68 65 20 73 |See one |of the s|
|00000130| 61 6d 70 6c 65 20 6d 61 | 6e 64 6f 63 73 20 66 6f |ample ma|ndocs fo|
|00000140| 72 20 61 20 67 6f 6f 64 | 20 65 78 61 6d 70 6c 65 |r a good| example|
|00000150| 20 6f 66 20 74 68 65 20 | 66 69 6c 65 20 66 6f 72 | of the |file for|
|00000160| 6d 61 74 2e 0a 0a 46 69 | 72 73 74 20 6c 69 6e 65 |mat...Fi|rst line|
|00000170| 20 6d 75 73 74 20 62 65 | 20 6f 66 20 74 68 65 20 | must be| of the |
|00000180| 66 6f 72 6d 3a 0a 0a 09 | 66 69 6c 65 6e 61 6d 65 |form:...|filename|
|00000190| 28 6e 29 20 2d 20 6f 70 | 74 69 6f 6e 61 6c 20 74 |(n) - op|tional t|
|000001a0| 65 78 74 20 68 65 72 65 | 0a 0a 77 68 65 72 65 20 |ext here|..where |
|000001b0| 15 66 69 6c 65 6e 61 6d | 65 10 20 69 73 20 74 68 |.filenam|e. is th|
|000001c0| 65 20 6f 75 74 70 75 74 | 20 6e 61 6d 65 20 6f 66 |e output| name of|
|000001d0| 20 74 68 65 20 6d 61 6e | 20 70 61 67 65 2c 20 61 | the man| page, a|
|000001e0| 6e 64 20 15 6e 10 20 69 | 73 20 61 20 73 65 63 74 |nd .n. i|s a sect|
|000001f0| 69 6f 6e 20 6e 75 6d 62 | 65 72 20 63 6f 72 72 65 |ion numb|er corre|
|00000200| 73 70 6f 6e 64 69 6e 67 | 20 77 69 74 68 20 74 68 |sponding| with th|
|00000210| 65 20 66 6f 6c 6c 6f 77 | 69 6e 67 20 28 6d 6f 64 |e follow|ing (mod|
|00000220| 65 6c 65 64 20 61 66 74 | 65 72 20 74 68 65 20 55 |eled aft|er the U|
|00000230| 6e 69 78 20 63 6f 6e 76 | 65 6e 74 69 6f 6e 29 3a |nix conv|ention):|
|00000240| 0a 0a 09 31 20 3d 20 55 | 73 65 72 20 43 6f 6d 6d |...1 = U|ser Comm|
|00000250| 61 6e 64 73 0a 09 32 20 | 3d 20 53 79 73 74 65 6d |ands..2 |= System|
|00000260| 20 4b 65 72 6e 65 6c 20 | 46 75 6e 63 74 69 6f 6e | Kernel |Function|
|00000270| 73 0a 09 33 20 3d 20 43 | 20 4c 69 62 72 61 72 79 |s..3 = C| Library|
|00000280| 20 46 75 6e 63 74 69 6f | 6e 73 0a 09 34 20 3d 20 | Functio|ns..4 = |
|00000290| 44 65 76 69 63 65 20 49 | 6e 74 65 72 66 61 63 65 |Device I|nterface|
|000002a0| 73 0a 09 35 20 3d 20 46 | 69 6c 65 20 46 6f 72 6d |s..5 = F|ile Form|
|000002b0| 61 74 73 0a 09 36 20 3d | 20 47 61 6d 65 73 20 61 |ats..6 =| Games a|
|000002c0| 6e 64 20 44 65 6d 6f 73 | 0a 09 37 20 3d 20 45 6e |nd Demos|..7 = En|
|000002d0| 76 69 72 6f 6e 6d 65 6e | 74 73 20 61 6e 64 20 54 |vironmen|ts and T|
|000002e0| 61 62 6c 65 73 0a 09 38 | 20 3d 20 4d 61 69 6e 74 |ables..8| = Maint|
|000002f0| 65 6e 61 6e 63 65 20 43 | 6f 6d 6d 61 6e 64 73 0a |enance C|ommands.|
|00000300| 0a 46 6f 6c 6c 6f 77 69 | 6e 67 20 74 68 61 74 20 |.Followi|ng that |
|00000310| 61 6e 64 20 61 20 62 6c | 61 6e 6b 20 6c 69 6e 65 |and a bl|ank line|
|00000320| 20 77 69 6c 6c 20 63 6f | 6d 65 20 74 68 65 20 72 | will co|me the r|
|00000330| 65 73 74 20 6f 66 20 74 | 68 65 20 66 69 6c 65 2c |est of t|he file,|
|00000340| 20 62 72 6f 6b 65 6e 20 | 69 6e 74 6f 20 73 75 62 | broken |into sub|
|00000350| 73 65 63 74 69 6f 6e 73 | 2e 20 20 45 61 63 68 20 |sections|.  Each |
|00000360| 73 75 62 73 65 63 74 69 | 6f 6e 20 77 69 6c 6c 20 |subsecti|on will |
|00000370| 73 74 61 72 74 20 77 69 | 74 68 20 69 74 73 20 6f |start wi|th its o|
|00000380| 77 6e 20 68 65 61 64 65 | 72 2c 20 69 73 6f 6c 61 |wn heade|r, isola|
|00000390| 74 65 64 20 6f 6e 20 61 | 20 6c 69 6e 65 20 61 6c |ted on a| line al|
|000003a0| 6c 20 69 6e 20 75 70 70 | 65 72 63 61 73 65 20 63 |l in upp|ercase c|
|000003b0| 68 61 72 61 63 74 65 72 | 73 20 61 6e 64 20 74 65 |haracter|s and te|
|000003c0| 72 6d 69 6e 61 74 65 64 | 20 77 69 74 68 20 61 20 |rminated| with a |
|000003d0| 63 6f 6c 6f 6e 2e 0a 0a | 64 6f 63 32 6d 61 6e 20 |colon...|doc2man |
|000003e0| 77 69 6c 6c 20 72 65 63 | 6f 67 6e 69 7a 65 20 73 |will rec|ognize s|
|000003f0| 6f 6d 65 20 70 61 72 74 | 69 63 75 6c 61 72 6c 79 |ome part|icularly|
|00000400| 20 63 6f 6d 6d 6f 6e 20 | 73 65 63 74 69 6f 6e 20 | common |section |
|00000410| 74 79 70 65 73 2c 20 77 | 68 6f 73 65 20 6e 61 6d |types, w|hose nam|
|00000420| 65 73 20 77 69 6c 6c 20 | 62 65 20 72 65 70 72 65 |es will |be repre|
|00000430| 73 65 6e 74 65 64 20 69 | 6e 20 74 68 65 20 6d 61 |sented i|n the ma|
|00000440| 6e 20 66 69 6c 65 20 77 | 69 74 68 20 61 6e 20 65 |n file w|ith an e|
|00000450| 6e 63 6f 64 65 64 20 69 | 64 65 6e 74 69 66 69 65 |ncoded i|dentifie|
|00000460| 72 20 74 6f 20 73 61 76 | 65 20 73 70 61 63 65 2e |r to sav|e space.|
|00000470| 20 20 41 6e 79 20 75 6e | 72 65 63 6f 67 6e 69 7a |  Any un|recogniz|
|00000480| 65 64 20 6f 6e 65 73 20 | 77 69 6c 6c 20 68 61 76 |ed ones |will hav|
|00000490| 65 20 74 68 65 69 72 20 | 74 65 78 74 20 72 65 70 |e their |text rep|
|000004a0| 72 65 73 65 6e 74 65 64 | 20 76 65 72 62 61 74 69 |resented| verbati|
|000004b0| 6d 2e 20 20 52 65 63 6f | 67 6e 69 7a 65 64 20 61 |m.  Reco|gnized a|
|000004c0| 72 65 3a 20 4e 41 4d 45 | 2c 20 53 59 4e 4f 50 53 |re: NAME|, SYNOPS|
|000004d0| 49 53 2c 20 44 45 53 43 | 52 49 50 54 49 4f 4e 2c |IS, DESC|RIPTION,|
|000004e0| 20 45 58 41 4d 50 4c 45 | 2c 20 50 4f 52 54 41 42 | EXAMPLE|, PORTAB|
|000004f0| 49 4c 49 54 59 2c 20 53 | 45 45 20 41 4c 53 4f 2c |ILITY, S|EE ALSO,|
|00000500| 20 46 49 4c 45 53 2c 20 | 42 55 47 53 2c 20 4e 4f | FILES, |BUGS, NO|
|00000510| 54 45 53 2c 20 4f 50 54 | 49 4f 4e 53 2c 20 52 45 |TES, OPT|IONS, RE|
|00000520| 54 55 52 4e 53 2c 20 41 | 55 54 48 4f 52 2c 20 4c |TURNS, A|UTHOR, L|
|00000530| 49 43 45 4e 43 45 0a 0a | 4e 6f 74 65 20 74 68 61 |ICENCE..|Note tha|
|00000540| 74 20 6f 66 74 65 6e 20 | 76 61 72 69 61 74 69 6f |t often |variatio|
|00000550| 6e 73 20 77 69 6c 6c 20 | 61 6c 73 6f 20 62 65 20 |ns will |also be |
|00000560| 72 65 63 6f 67 6e 69 7a | 65 64 2c 20 65 2e 67 2e |recogniz|ed, e.g.|
|00000570| 20 70 6c 75 72 61 6c 73 | 20 61 6e 64 20 73 75 63 | plurals| and suc|
|00000580| 68 2e 20 57 68 65 6e 20 | 13 6d 61 6e 10 20 66 6f |h. When |.man. fo|
|00000590| 72 6d 61 74 73 20 74 68 | 65 20 6f 75 74 70 75 74 |rmats th|e output|
|000005a0| 2c 20 74 68 65 20 73 75 | 62 73 65 63 74 69 6f 6e |, the su|bsection|
|000005b0| 20 68 65 61 64 65 72 73 | 20 77 69 6c 6c 20 62 65 | headers| will be|
|000005c0| 20 64 69 73 70 6c 61 79 | 65 64 20 66 6c 75 73 68 | display|ed flush|
|000005d0| 20 6c 65 66 74 20 61 6e | 64 20 69 6e 20 62 6f 6c | left an|d in bol|
|000005e0| 64 20 74 79 70 65 2e 0a | 0a 54 68 65 20 62 6f 64 |d type..|.The bod|
|000005f0| 79 20 6f 66 20 74 68 65 | 20 73 65 63 74 69 6f 6e |y of the| section|
|00000600| 2c 20 77 68 69 63 68 20 | 66 6f 6c 6c 6f 77 73 2c |, which |follows,|
|00000610| 20 77 69 6c 6c 20 62 65 | 20 64 69 73 70 6c 61 79 | will be| display|
|00000620| 65 64 20 6a 75 73 74 69 | 66 69 65 64 2e 20 20 48 |ed justi|fied.  H|
|00000630| 6f 77 65 76 65 72 2c 20 | 70 61 72 61 67 72 61 70 |owever, |paragrap|
|00000640| 68 73 20 6d 61 79 20 62 | 65 20 62 72 6f 6b 65 6e |hs may b|e broken|
|00000650| 20 61 73 20 66 72 65 71 | 75 65 6e 74 6c 79 20 61 | as freq|uently a|
|00000660| 73 20 64 65 73 69 72 65 | 64 20 66 6f 72 20 76 69 |s desire|d for vi|
|00000670| 73 75 61 6c 20 63 6c 61 | 72 69 74 79 20 69 6e 20 |sual cla|rity in |
|00000680| 74 68 65 20 61 73 63 69 | 69 20 66 69 6c 65 20 2d |the asci|i file -|
|00000690| 2d 20 64 6f 63 32 6d 61 | 6e 20 77 69 6c 6c 20 61 |- doc2ma|n will a|
|000006a0| 75 74 6f 6d 61 74 69 63 | 61 6c 6c 79 20 73 74 72 |utomatic|ally str|
|000006b0| 69 70 20 74 68 65 20 6c | 69 6e 65 66 65 65 64 73 |ip the l|inefeeds|
|000006c0| 2e 20 20 4d 75 6c 74 69 | 70 6c 65 20 70 61 72 61 |.  Multi|ple para|
|000006d0| 67 72 61 70 68 73 20 73 | 68 6f 75 6c 64 20 62 65 |graphs s|hould be|
|000006e0| 20 73 65 70 61 72 61 74 | 65 64 20 62 79 20 61 20 | separat|ed by a |
|000006f0| 62 6c 61 6e 6b 20 6c 69 | 6e 65 20 2d 2d 20 74 68 |blank li|ne -- th|
|00000700| 69 73 20 77 69 6c 6c 20 | 62 65 20 72 65 63 6f 67 |is will |be recog|
|00000710| 6e 69 7a 65 64 20 61 6e | 64 20 66 6f 72 6d 61 74 |nized an|d format|
|00000720| 74 69 6e 67 20 77 69 6c | 6c 20 62 65 20 64 6f 6e |ting wil|l be don|
|00000730| 65 20 61 63 63 6f 72 64 | 69 6e 67 6c 79 2e 20 20 |e accord|ingly.  |
|00000740| 54 68 65 72 65 20 69 73 | 20 6e 6f 20 6c 69 6d 69 |There is| no limi|
|00000750| 74 20 74 6f 20 74 68 65 | 20 6e 75 6d 62 65 72 20 |t to the| number |
|00000760| 6f 66 20 70 61 72 61 67 | 72 61 70 68 73 20 70 65 |of parag|raphs pe|
|00000770| 72 20 73 75 62 73 65 63 | 74 69 6f 6e 3b 20 73 65 |r subsec|tion; se|
|00000780| 63 74 69 6f 6e 73 20 61 | 72 65 20 61 73 73 75 6d |ctions a|re assum|
|00000790| 65 64 20 74 6f 20 65 6e | 64 20 77 68 65 6e 20 61 |ed to en|d when a|
|000007a0| 20 6c 69 6e 65 20 6d 65 | 65 74 69 6e 67 20 74 68 | line me|eting th|
|000007b0| 65 20 63 72 69 74 65 72 | 69 61 20 66 6f 72 20 61 |e criter|ia for a|
|000007c0| 20 68 65 61 64 65 72 20 | 61 62 6f 76 65 20 69 73 | header |above is|
|000007d0| 20 65 6e 63 6f 75 6e 74 | 65 72 65 64 2e 0a 0a 53 | encount|ered...S|
|000007e0| 70 65 63 69 61 6c 20 66 | 6f 72 6d 61 74 74 69 6e |pecial f|ormattin|
|000007f0| 67 20 63 6f 64 65 73 20 | 6d 61 79 20 62 65 20 65 |g codes |may be e|
|00000800| 6d 62 65 64 64 65 64 20 | 77 69 74 68 69 6e 20 74 |mbedded |within t|
|00000810| 68 65 20 66 69 6c 65 20 | 66 6f 72 20 63 68 61 72 |he file |for char|
|00000820| 61 63 74 65 72 20 74 79 | 70 65 20 76 61 72 69 65 |acter ty|pe varie|
|00000830| 74 79 2e 20 20 46 6f 6c | 6c 6f 77 69 6e 67 20 61 |ty.  Fol|lowing a|
|00000840| 72 65 20 61 20 6c 69 6e | 65 20 6f 66 20 73 65 74 |re a lin|e of set|
|00000850| 20 74 79 70 65 2c 20 61 | 6e 64 20 69 74 73 20 66 | type, a|nd its f|
|00000860| 6f 72 6d 61 74 74 65 64 | 20 63 6f 75 6e 74 65 72 |ormatted| counter|
|00000870| 70 61 72 74 3a 0a 0a 09 | 15 54 6f 20 67 65 74 10 |part:...|.To get.|
|00000880| 3a 09 50 6c 61 69 6e 2c | 20 13 69 74 61 6c 69 63 |:.Plain,| .italic|
|00000890| 69 7a 65 64 10 2c 20 02 | 62 6f 6c 64 65 64 10 2c |ized., .|bolded.,|
|000008a0| 20 15 75 6e 64 65 72 6c | 69 6e 65 64 10 0a 0a 09 | .underl|ined....|
|000008b0| 15 54 79 70 65 10 3a 09 | 50 6c 61 69 6e 2c 20 7b |.Type.:.|Plain, {|
|000008c0| 69 74 61 6c 69 63 69 7a | 65 64 7d 2c 20 7c 62 6f |italiciz|ed}, |bo|
|000008d0| 6c 64 65 64 7c 2c 20 5f | 75 6e 64 65 72 6c 69 6e |lded|, _|underlin|
|000008e0| 65 64 5f 0a 0a 4e 6f 74 | 65 2c 20 68 6f 77 65 76 |ed_..Not|e, howev|
|000008f0| 65 72 2c 20 74 68 61 74 | 20 74 6f 20 75 73 65 20 |er, that| to use |
|00000900| 6f 6e 65 20 6f 66 20 74 | 68 65 20 61 62 6f 76 65 |one of t|he above|
|00000910| 20 66 6f 72 6d 61 74 74 | 69 6e 67 20 63 68 61 72 | formatt|ing char|
|00000920| 61 63 74 65 72 73 20 6c | 69 74 65 72 61 6c 6c 79 |acters l|iterally|
|00000930| 20 69 74 20 6d 75 73 74 | 20 62 65 20 65 73 63 61 | it must| be esca|
|00000940| 70 65 64 20 77 69 74 68 | 20 61 20 62 61 63 6b 73 |ped with| a backs|
|00000950| 6c 61 73 68 20 28 61 73 | 20 6d 75 73 74 20 61 20 |lash (as| must a |
|00000960| 62 61 63 6b 73 6c 61 73 | 68 20 69 74 73 65 6c 66 |backslas|h itself|
|00000970| 29 3a 0a 0a 09 15 54 6f | 20 67 65 74 10 3a 09 59 |):....To| get.:.Y|
|00000980| 6f 75 20 77 69 6c 6c 20 | 6e 6f 74 69 63 65 20 74 |ou will |notice t|
|00000990| 68 65 20 5f 73 79 6d 62 | 6f 6c 73 5c 20 7c 7c 7c |he _symb|ols\ ||||
|000009a0| 20 69 6e 20 74 68 69 73 | 20 74 65 78 74 7d 2e 0a | in this| text}..|
|000009b0| 0a 09 15 54 79 70 65 10 | 3a 09 59 6f 75 20 77 69 |...Type.|:.You wi|
|000009c0| 6c 6c 20 6e 6f 74 69 63 | 65 20 74 68 65 20 5c 5f |ll notic|e the \_|
|000009d0| 73 79 6d 62 6f 6c 73 5c | 5c 20 5c 7c 5c 7c 5c 7c |symbols\|\ \|\|\||
|000009e0| 20 69 6e 20 74 68 69 73 | 20 74 65 78 74 5c 7d 2e | in this| text\}.|
|000009f0| 0a 0a 54 68 65 20 66 69 | 6c 65 20 6d 61 79 20 73 |..The fi|le may s|
|00000a00| 69 6d 70 6c 79 20 65 6e | 64 20 61 66 74 65 72 20 |imply en|d after |
|00000a10| 74 68 65 20 6c 61 73 74 | 20 73 65 63 74 69 6f 6e |the last| section|
|00000a20| 27 73 20 74 65 78 74 2e | 0a 00 4f 4e 6f 6e 65 20 |'s text.|..ONone |
|00000a30| 61 74 20 70 72 65 73 65 | 6e 74 2e 0a 00 51 13 6d |at prese|nt...Q.m|
|00000a40| 61 6e 32 64 6f 63 10 2c | 20 13 67 75 69 64 65 32 |an2doc.,| .guide2|
|00000a50| 6d 61 6e 10 2c 20 13 6d | 61 6e 10 0a 00 00       |man., .m|an....  |
+--------+-------------------------+-------------------------+--------+--------+